home *** CD-ROM | disk | FTP | other *** search
/ Directorty Opus 5 - Magellan 2 / Opus 5 - Magellan 2.iso / Extras / ArcByName / ArcByName.doc next >
Text File  |  1995-09-28  |  5KB  |  162 lines

  1. ************************** DOCUMENTATION FILE FOR *************************
  2.  
  3.                               ArcByName.DOpus5
  4.                                    V1.0
  5.                               by Willy Gwerder
  6.                            for DirectoryOpus V5.11
  7.                              with LhA and/or LZX
  8.  
  9. ************************* written by Willy Gwerder ************************
  10.  
  11.  
  12. Did you ever want to...
  13. -----------------------
  14.  
  15. ...archive a row of directories or files as separate archives with your
  16. DirectoryOpus5? So you've surely recognized that it is quite laborious to
  17. give a name for each archive. The problem's solution is this AREXX-program
  18. for DOpus5.
  19.  
  20.  
  21. What it does
  22. ------------
  23.  
  24. With ArcByName you can archive the selected entries (this can be files or
  25. directories) by copying or moving them with LhA/LZX to the current
  26. destination. The archives will have the same name as the original entries
  27. but with the extension .lha or .lzx.
  28.  
  29.  
  30. Requirements
  31. ------------
  32.  
  33. - An Amiga.
  34.   (For best performance one with a 68060 processor, a hyperfast graphiccard
  35.   with a resolution of 1600X1280 and a one gigabyte harddrive. But actually
  36.   it will do if you meet the requirements of DOpus5).
  37. - Directory Opus 5.11
  38. - The archiver programs Lha and/or LZX in your c: directory.
  39.  
  40.  
  41. Installation
  42. ------------
  43.  
  44. I suggest you copy ArcByName.DOpus5 to the ARexx drawer in your DOpus5:
  45. directory. You can put it on a button or into the user-menu. Read your
  46. DOpus manual to see how to do this. Don't forget to set the cycle-gadget of
  47. the function editor to Arexx! Call ArcByName with the following arguments:
  48.  
  49. ArcByName.DOpus5 lha {Qp}                or
  50. ArcByName.DOpus5 lzx {Qp}
  51.  
  52. As you can see, you have the choice between lha or lzx as archiver program.
  53. (If you like both, define two buttons, one with lha, the other with lzx).
  54.  
  55. The argument {Qp} is needed to find DOpus' ARexx-port. If you leave it
  56. away, the programm will use the port of the first started DOpus5 (DOPUS.1).
  57.  
  58.  
  59. How to use it
  60. -------------
  61.  
  62. It is just like copying or moving files. Select your source and
  63. destination, mark the entries you want to process and start ArcByName. A
  64. Requester will popup and ask:
  65.  
  66. "Delete source-files after archiving?"
  67.  
  68. You can either select YES or NO. If you hit NO, the selected entries will
  69. be copied (as archives) to your destination. If you hit YES, another
  70. requester will pop up and ask:
  71.  
  72. "Are you sure???"
  73.  
  74. Click YES and the files will be MOVED to the destination. Click NO to go
  75. back to the first requester.
  76.  
  77. If you got through all those requesters the archiving starts. A progress
  78. indicator and an output-window will be opened. The output-window shows the
  79. file that's archived at the moment. The progress indicator shows the
  80. processed entry.
  81.  
  82. Note that the entries appearing in the destination directory are only
  83. temporary as long as the program runs. Instead of the file size the number
  84. of the processed entry will be shown. When the job is done the directory
  85. will be rescanned to get the correct sizes.
  86.  
  87. Source- and destination directory can be the same. This is especially
  88. useful with the "delete source-files" option to shrink a directory.
  89. Note: Because selected directories are only deleted if they were archived
  90. entirely before, get sure you have enough free disk space.
  91.  
  92. The XXX.info files don't need to be selected, because they are included
  93. into the archive automatically, but of course it doesn't matter if you do
  94. select them. However, you cannot make an archive only from an *.info file.
  95. (It wouldn't be very sensible anyway). The program just overrides entries
  96. like this.
  97.  
  98.  
  99. How to abort
  100. -------------
  101.  
  102. There are two ways to abort the program:
  103.  
  104. 1st: You can stop the program by clicking ABORT in the progress indicator.
  105. This will stop the archiver as soon as it tries to access the next selected
  106. entry. So if you're processing bigger directories it may take a while.
  107.  
  108. 2nd: If you want to stop processing immediately, then click into the
  109. output-window to activate it (the pointer is no longer busy now) and press
  110. CTRL-C. The window will close immediately. The incomplete archive will not
  111. be saved and (of course) the source file will NOT be deleted.
  112.  
  113.  
  114. Legal Stuff
  115. -----------
  116.  
  117. You use the program at your own risk. I cannot be made responsible for any
  118. damage or lost data caused by this program.
  119.  
  120. ArcByName is Public Domain and may not be sold for profit. You can copy,
  121. spread and/or alter it. The two doc files (english and german) must be
  122. included.
  123.  
  124. If you alter the program text and want to spread it afterwards, so please
  125. remark the changes in the doc-file. Feel free to send me a copy of the
  126. program to show me the improvements :-). If you have any bug reports or
  127. ideas for improvements please contact me. My address:
  128.  
  129.  
  130. Willy Gwerder
  131. Grundstrasse 97
  132. 6430 Schwyz
  133. Switzerland
  134.  
  135. e-mail: eagwerde@ztl.ch
  136.  
  137.  
  138. ArcByName may also be seen as "Cardware" or "e-mail-ware", so if you like
  139. it, send me a nice postcard or drop me a line by e-mail.
  140.  
  141.  
  142. History
  143. -------
  144.  
  145. This Program is based on V1.2 of my ARexx-program LhAByName.rexx for DOpus
  146. 4.11 from 30.09.1994.
  147.  
  148.  
  149. 29.09.1995  V1.0  First public release
  150.  
  151.  
  152. Tests
  153. -----
  154.  
  155. This program has been tested in many ways on my:
  156.  
  157. A4000/40
  158.  
  159. with Directory Opus V5.11 (german version)
  160. LhA V1.38e
  161. LZX V1.20e version for 68040/68060
  162.